\subsection{bmp.h-Dateireferenz}
\label{bmp_8h}\index{bmp.h@{bmp.h}}
Funktionen zum Schreiben und Lesen einer BMP Datei. 

{\tt \#include \char`\"{}lcv-config.h\char`\"{}}\par
{\tt \#include \char`\"{}lcv-structs.h\char`\"{}}\par
\subsubsection*{Funktionen}
\begin{CompactItemize}
\item 
char {\bf lcv\_\-write\_\-bmp} (const {\bf lcv\_\-picture} pic, const char $\ast$filename)
\begin{CompactList}\small\item\em Speichert ein \doxyref{lcv\_\-picture}{S.}{structlcv__picture} Strukt im BMP-Format ab. \item\end{CompactList}\item 
{\bf lcv\_\-picture} {\bf lcv\_\-read\_\-bmp} (const char $\ast$filename)
\begin{CompactList}\small\item\em Liest ein Bitmap vom Dateisystem ein und wandelt es in ein \doxyref{lcv\_\-picture}{S.}{structlcv__picture} um. \item\end{CompactList}\item 
int {\bf lcv\_\-get\_\-data\_\-offset} (unsigned char $\ast$header)
\begin{CompactList}\small\item\em Liest den Offset der Bilderdaten aus einem BMP-Header. \item\end{CompactList}\item 
void {\bf lcv\_\-set\_\-data\_\-offset} (unsigned char $\ast$header, int offset)
\begin{CompactList}\small\item\em Schreibt den Bilddaten-Offset Wert in einen BMP-Header. \item\end{CompactList}\item 
int {\bf lcv\_\-get\_\-height} (unsigned char $\ast$header)
\begin{CompactList}\small\item\em Liest die Bildhöhe aus einem BMP-Header. \item\end{CompactList}\item 
void {\bf lcv\_\-set\_\-height} (unsigned char $\ast$header, int height)
\begin{CompactList}\small\item\em Schreibt die Bildhöhe in einen BMP-Header. \item\end{CompactList}\item 
int {\bf lcv\_\-get\_\-width} (unsigned char $\ast$header)
\begin{CompactList}\small\item\em Liest die Bildbreite aus einem BMP-Header. \item\end{CompactList}\item 
void {\bf lcv\_\-set\_\-width} (unsigned char $\ast$header, int width)
\begin{CompactList}\small\item\em Schreibt die Bildbreite in einen BMP-Header. \item\end{CompactList}\item 
int {\bf lcv\_\-get\_\-colordepth} (unsigned char $\ast$header)
\begin{CompactList}\small\item\em Liest die Farbtiefe aus einem BMP-Header. \item\end{CompactList}\end{CompactItemize}


\subsubsection{Ausführliche Beschreibung}
Funktionen zum Schreiben und Lesen einer BMP Datei. 

\begin{Desc}
\item[Autor:]Daniel Kummer, Sebastian Kummer \end{Desc}
\begin{Desc}
\item[Datum:]Donnerstag, Dezember 12, 2007 \end{Desc}
\begin{Desc}
\item[Version:]1.0 \end{Desc}


Definiert in Datei {\bf bmp.h}.

\subsubsection{Dokumentation der Funktionen}
\index{bmp.h@{bmp.h}!lcv_get_colordepth@{lcv\_\-get\_\-colordepth}}
\index{lcv_get_colordepth@{lcv\_\-get\_\-colordepth}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}int lcv\_\-get\_\-colordepth (unsigned char $\ast$ {\em header})}\hfill\label{bmp_8h_747d30df5a1c05fd51e331c6d1864b13}


Liest die Farbtiefe aus einem BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Farbtiefe \end{Desc}


Definiert in Zeile 184 der Datei bmp.c.\index{bmp.h@{bmp.h}!lcv_get_data_offset@{lcv\_\-get\_\-data\_\-offset}}
\index{lcv_get_data_offset@{lcv\_\-get\_\-data\_\-offset}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}int lcv\_\-get\_\-data\_\-offset (unsigned char $\ast$ {\em header})}\hfill\label{bmp_8h_e479adb4ac58f6d6aa93c6ec6cd33c6f}


Liest den Offset der Bilderdaten aus einem BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Offset der Daten \end{Desc}


Definiert in Zeile 154 der Datei bmp.c.

Benutzt get\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_get_height@{lcv\_\-get\_\-height}}
\index{lcv_get_height@{lcv\_\-get\_\-height}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}int lcv\_\-get\_\-height (unsigned char $\ast$ {\em header})}\hfill\label{bmp_8h_705a23754fa604d27b8f0562388f8e99}


Liest die Bildhöhe aus einem BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Höhe des Bildes \end{Desc}


Definiert in Zeile 164 der Datei bmp.c.

Benutzt get\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_get_width@{lcv\_\-get\_\-width}}
\index{lcv_get_width@{lcv\_\-get\_\-width}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}int lcv\_\-get\_\-width (unsigned char $\ast$ {\em header})}\hfill\label{bmp_8h_cb2e0a15670d489e379065f189d36cd3}


Liest die Bildbreite aus einem BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Breite des Bildes \end{Desc}


Definiert in Zeile 174 der Datei bmp.c.

Benutzt get\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_read_bmp@{lcv\_\-read\_\-bmp}}
\index{lcv_read_bmp@{lcv\_\-read\_\-bmp}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}{\bf lcv\_\-picture} lcv\_\-read\_\-bmp (const char $\ast$ {\em filename})}\hfill\label{bmp_8h_db9d72348ad074e3aa31306fd9c0f410}


Liest ein Bitmap vom Dateisystem ein und wandelt es in ein \doxyref{lcv\_\-picture}{S.}{structlcv__picture} um. 

Das Bitmap muss eine Farbtiefe von 24-bit aufweisen und \char`\"{}bottom-up\char`\"{} abgelegt sein \begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em filename}]Dateiname, bzw. Pfad \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Bild in Struktur \end{Desc}


Definiert in Zeile 75 der Datei bmp.c.

Benutzt BMP\_\-HEADER\_\-LENGTH, lcv\_\-picture::data, FALSE, lcv\_\-picture::height, IMG\_\-BGR, lcv\_\-get\_\-colordepth(), lcv\_\-get\_\-data\_\-offset(), lcv\_\-get\_\-height(), lcv\_\-get\_\-width(), lcv\_\-picture::length, TRUE, lcv\_\-picture::type und lcv\_\-picture::width.\index{bmp.h@{bmp.h}!lcv_set_data_offset@{lcv\_\-set\_\-data\_\-offset}}
\index{lcv_set_data_offset@{lcv\_\-set\_\-data\_\-offset}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}void lcv\_\-set\_\-data\_\-offset (unsigned char $\ast$ {\em header}, int {\em offset})}\hfill\label{bmp_8h_5558ce5030c2351ee51f4aceb3c2cc19}


Schreibt den Bilddaten-Offset Wert in einen BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \item[{\em offset}]Offset der Daten \end{description}
\end{Desc}


Definiert in Zeile 159 der Datei bmp.c.

Benutzt set\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_set_height@{lcv\_\-set\_\-height}}
\index{lcv_set_height@{lcv\_\-set\_\-height}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}void lcv\_\-set\_\-height (unsigned char $\ast$ {\em header}, int {\em height})}\hfill\label{bmp_8h_195e45d074ca98f4a6223df1222beb03}


Schreibt die Bildhöhe in einen BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \item[{\em height}]Höhe des Bildes \end{description}
\end{Desc}


Definiert in Zeile 169 der Datei bmp.c.

Benutzt set\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_set_width@{lcv\_\-set\_\-width}}
\index{lcv_set_width@{lcv\_\-set\_\-width}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}void lcv\_\-set\_\-width (unsigned char $\ast$ {\em header}, int {\em width})}\hfill\label{bmp_8h_5f996c726707fcfa7b04f47e649e6503}


Schreibt die Bildbreite in einen BMP-Header. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em header}]BMP-Header \item[{\em height}]Breite des Bildes \end{description}
\end{Desc}


Definiert in Zeile 179 der Datei bmp.c.

Benutzt set\_\-a\_\-4byte\_\-value().\index{bmp.h@{bmp.h}!lcv_write_bmp@{lcv\_\-write\_\-bmp}}
\index{lcv_write_bmp@{lcv\_\-write\_\-bmp}!bmp.h@{bmp.h}}
\paragraph{\setlength{\rightskip}{0pt plus 5cm}char lcv\_\-write\_\-bmp (const {\bf lcv\_\-picture} {\em pic}, const char $\ast$ {\em filename})}\hfill\label{bmp_8h_019bbd8825f65533aa3651c087951d3d}


Speichert ein \doxyref{lcv\_\-picture}{S.}{structlcv__picture} Strukt im BMP-Format ab. 

\begin{Desc}
\item[Parameter:]
\begin{description}
\item[{\em pic}]Das zu speichernde Bild \item[{\em filename}]Dateiname, bzw. Pfad \end{description}
\end{Desc}
\begin{Desc}
\item[Rückgabe:]Erfolgsmeldung (positiv) oder Fehlernummer (negativ) \end{Desc}


Definiert in Zeile 37 der Datei bmp.c.

Benutzt BMP\_\-HEADER\_\-LENGTH, bmphead\_\-bgr, lcv\_\-picture::data, lcv\_\-picture::height, IMG\_\-BGR, lcv\_\-clone\_\-picture(), lcv\_\-gray2rgb(), lcv\_\-set\_\-height(), lcv\_\-set\_\-width(), lcv\_\-picture::length, TRUE, lcv\_\-picture::type und lcv\_\-picture::width.